/Services/GetDocumentsStatus (Method)

Description

Get xml data related to documents of a certain status within a specified date range.

Request (GetDocumentsStatusSoapIn)

The request body is of type GetDocumentsStatus.

Request Body Parameters

Name	Description	Data Type
pstr_APICode	The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings.	xml:string
pstr_StartDate	The date to start the search.	xml:string
pstr_EndDate	The date to end the search.	xml:string
pstr_Status	The status of the documents searched for.	xml:string
pstr_Signers	A comma, space, or semicolon seperated list of email addresses related to the documents searched for.	xml:string

Response (GetDocumentsStatusSoapOut)

The response body is of type GetDocumentsStatusResponse.

Response Body Parameters

Name	Description	Data Type
GetDocumentsStatusResult	xml data or error message.	xml:string

Sample Data

Most common scenarios involve states 0, 1, 4, 7, and 9
0 - AwaitingSignature - document is ready to receive signatures
1 - Signed - all signature received
2 - ConvertingToPdf - document is converting to PDF (this is only applicable to HTML documents)
3 - AwaitingVerification - if third party verification is used, then a document is in a holding state until the verification is passed
4 - PartiallySigned - one of the signers signed the document
5 - Archived - document has been archived by the owner
6 - Revoked - document is signed but signer revoked it as not a valid signature
7 - Declined - document has been declined by one of the signers
8 - ConversionFailed - unable to convert to PDF, so document cannot be processed (this is only applicable to HTML documents)
9 - Expired - document is expired

Example

Sample Call:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:GetDocumentsStatus>
         <ser:pstr_APICode>88F54943-115A-4BD7-B325-52262BCA2F98</ser:pstr_APICode>
         <ser:pstr_StartDate>2014/5/1</ser:pstr_StartDate>
         <ser:pstr_EndDate>2014/5/25</ser:pstr_EndDate>
         <ser:pstr_Status>signed</ser:pstr_Status>
         
         <ser:pstr_Signers></ser:pstr_Signers>
      </ser:GetDocumentsStatus>
   </soap:Body>
</soap:Envelope>

Sample Response:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetDocumentsStatusResponse xmlns="http://apps.sertifi.net/services/">
         <GetDocumentsStatusResult><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<CurrentStatus>
<StartDate>2014/5/1</StartDate>
<EndDate>2014/5/25</EndDate>
<Document>
    <FileID>6ohWqLSG424=</FileID>
    <DocumentID>TieMLwLwLpE=</DocumentID>
    <Name>checkboxes!</Name>
    <Status>Signed</Status>
    <DateCreated>5/20/2014 2:40:58 PM</DateCreated>
    <DateSigned>5/20/2014 2:43:41 PM</DateSigned>
</Document>
<Document>
    <FileID>4k2374h5ilU=</FileID>
    <DocumentID>wOQ8EjI0Zj4=</DocumentID>
    <Name>checkboxes!</Name>
    <Status>Signed</Status>
    <DateCreated>5/1/2014 1:10:31 PM</DateCreated>
    <DateSigned>5/1/2014 1:25:49 PM</DateSigned>
</Document>
</CurrentStatus>]]></GetDocumentsStatusResult>
      </GetDocumentsStatusResponse>
   </soap:Body>
</soap:Envelope>

Remarks

Common Errors include:
"ERROR: Invalid API Code"
"ERROR: pstr_StartDate is invalid."
"ERROR: pstr_EndDate is invalid."
"ERROR: Status cant be empty or null."
"ERROR: pstr_Status is invalid."
"ERROR: pstr_Signers is invalid: ..."